<!DOCTYPE html>
<html lang="en">


<!-- Mirrored from www.django-rest-framework.org/community/3.11-announcement/ by HTTrack Website Copier/3.x [XR&CO'2014], Sun, 13 Sep 2020 09:33:10 GMT -->
<!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=utf-8" /><!-- /Added by HTTrack -->
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  <meta charset="utf-8">
  <title>3.11 Announcement - Django REST framework</title>
  <link href="../../img/favicon.ico" rel="icon" type="image/x-icon">
  <link rel="canonical" href="index.html" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <meta name="description" content="Django, API, REST, 3.11 Announcement">
  <meta name="author" content="Tom Christie">

  <!-- Le styles -->
  <link href="../../css/prettify.css" rel="stylesheet">
  <link href="../../css/bootstrap.css" rel="stylesheet">
  <link href="../../css/bootstrap-responsive.css" rel="stylesheet">
  <link href="../../css/default.css" rel="stylesheet">


  <script type="text/javascript">
    var _gaq = _gaq || [];
    _gaq.push(['_setAccount', 'UA-18852272-2']);
    _gaq.push(['_trackPageview']);

    (function() {
      var ga = document.createElement('script');
      ga.type = 'text/javascript';
      ga.async = true;
      ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
      var s = document.getElementsByTagName('script')[0];
      s.parentNode.insertBefore(ga, s);
    })();
  </script>

  <style>
  #sidebarInclude img {
      margin-bottom: 10px;
  }
  #sidebarInclude a.promo {
      color: black;
  }
    @media (max-width: 767px) {
      div.promo {
        display: none;
      }
    }
  </style>
</head>
<body onload="prettyPrint()" class="-page">

  <div class="wrapper">
        <div class="navbar navbar-inverse navbar-fixed-top">
      <div class="navbar-inner">
        <div class="container-fluid">
          <a class="repo-link btn btn-primary btn-small" href="https://github.com/encode/django-rest-framework/tree/master">GitHub</a>
          <a class="repo-link btn btn-inverse btn-small " rel="next" href="../3.10-announcement/index.html">
            Next <i class="icon-arrow-right icon-white"></i>
          </a>
          <a class="repo-link btn btn-inverse btn-small " rel="prev" href="../release-notes/index.html">
            <i class="icon-arrow-left icon-white"></i> Previous
          </a>
          <a id="search_modal_show" class="repo-link btn btn-inverse btn-small" href="#mkdocs_search_modal" data-toggle="modal" data-target="#mkdocs_search_modal"><i class="icon-search icon-white"></i> Search</a>
          <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </a>
          <a class="brand" href="../../index.html">Django REST framework</a>
          <div class="nav-collapse collapse">
            
            <!-- Main navigation -->
            <ul class="nav navbar-nav">
               
              <li >
                <a href="../../index.html">Home</a>
              </li>
                
              <li class="dropdown">
                <a href="#" class="dropdown-toggle" data-toggle="dropdown">Tutorial <b class="caret"></b></a>
                <ul class="dropdown-menu">
                  
                  <li >
                    <a href="../../tutorial/quickstart/index.html">Quickstart</a>
                  </li>
                  
                  <li >
                    <a href="../../tutorial/1-serialization/index.html">1 - Serialization</a>
                  </li>
                  
                  <li >
                    <a href="../../tutorial/2-requests-and-responses/index.html">2 - Requests and responses</a>
                  </li>
                  
                  <li >
                    <a href="../../tutorial/3-class-based-views/index.html">3 - Class based views</a>
                  </li>
                  
                  <li >
                    <a href="../../tutorial/4-authentication-and-permissions/index.html">4 - Authentication and permissions</a>
                  </li>
                  
                  <li >
                    <a href="../../tutorial/5-relationships-and-hyperlinked-apis/index.html">5 - Relationships and hyperlinked APIs</a>
                  </li>
                  
                  <li >
                    <a href="../../tutorial/6-viewsets-and-routers/index.html">6 - Viewsets and routers</a>
                  </li>
                  
                </ul>
              </li>
                
              <li class="dropdown">
                <a href="#" class="dropdown-toggle" data-toggle="dropdown">API Guide <b class="caret"></b></a>
                <ul class="dropdown-menu">
                  
                  <li >
                    <a href="../../api-guide/requests/index.html">Requests</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/responses/index.html">Responses</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/views/index.html">Views</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/generic-views/index.html">Generic views</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/viewsets/index.html">Viewsets</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/routers/index.html">Routers</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/parsers/index.html">Parsers</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/renderers/index.html">Renderers</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/serializers/index.html">Serializers</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/fields/index.html">Serializer fields</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/relations/index.html">Serializer relations</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/validators/index.html">Validators</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/authentication/index.html">Authentication</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/permissions/index.html">Permissions</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/caching/index.html">Caching</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/throttling/index.html">Throttling</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/filtering/index.html">Filtering</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/pagination/index.html">Pagination</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/versioning/index.html">Versioning</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/content-negotiation/index.html">Content negotiation</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/metadata/index.html">Metadata</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/schemas/index.html">Schemas</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/format-suffixes/index.html">Format suffixes</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/reverse/index.html">Returning URLs</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/exceptions/index.html">Exceptions</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/status-codes/index.html">Status codes</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/testing/index.html">Testing</a>
                  </li>
                  
                  <li >
                    <a href="../../api-guide/settings/index.html">Settings</a>
                  </li>
                  
                </ul>
              </li>
                
              <li class="dropdown">
                <a href="#" class="dropdown-toggle" data-toggle="dropdown">Topics <b class="caret"></b></a>
                <ul class="dropdown-menu">
                  
                  <li >
                    <a href="../../topics/documenting-your-api/index.html">Documenting your API</a>
                  </li>
                  
                  <li >
                    <a href="../../topics/api-clients/index.html">API Clients</a>
                  </li>
                  
                  <li >
                    <a href="../../topics/internationalization/index.html">Internationalization</a>
                  </li>
                  
                  <li >
                    <a href="../../topics/ajax-csrf-cors/index.html">AJAX, CSRF & CORS</a>
                  </li>
                  
                  <li >
                    <a href="../../topics/html-and-forms/index.html">HTML & Forms</a>
                  </li>
                  
                  <li >
                    <a href="../../topics/browser-enhancements/index.html">Browser Enhancements</a>
                  </li>
                  
                  <li >
                    <a href="../../topics/browsable-api/index.html">The Browsable API</a>
                  </li>
                  
                  <li >
                    <a href="../../topics/rest-hypermedia-hateoas/index.html">REST, Hypermedia & HATEOAS</a>
                  </li>
                  
                </ul>
              </li>
                
              <li class="dropdown active">
                <a href="#" class="dropdown-toggle" data-toggle="dropdown">Community <b class="caret"></b></a>
                <ul class="dropdown-menu">
                  
                  <li >
                    <a href="../tutorials-and-resources/index.html">Tutorials and Resources</a>
                  </li>
                  
                  <li >
                    <a href="../third-party-packages/index.html">Third Party Packages</a>
                  </li>
                  
                  <li >
                    <a href="../contributing/index.html">Contributing to REST framework</a>
                  </li>
                  
                  <li >
                    <a href="../project-management/index.html">Project management</a>
                  </li>
                  
                  <li >
                    <a href="../release-notes/index.html">Release Notes</a>
                  </li>
                  
                  <li class="active" >
                    <a href="index.html">3.11 Announcement</a>
                  </li>
                  
                  <li >
                    <a href="../3.10-announcement/index.html">3.10 Announcement</a>
                  </li>
                  
                  <li >
                    <a href="../3.9-announcement/index.html">3.9 Announcement</a>
                  </li>
                  
                  <li >
                    <a href="../3.8-announcement/index.html">3.8 Announcement</a>
                  </li>
                  
                  <li >
                    <a href="../3.7-announcement/index.html">3.7 Announcement</a>
                  </li>
                  
                  <li >
                    <a href="../3.6-announcement/index.html">3.6 Announcement</a>
                  </li>
                  
                  <li >
                    <a href="../3.5-announcement/index.html">3.5 Announcement</a>
                  </li>
                  
                  <li >
                    <a href="../3.4-announcement/index.html">3.4 Announcement</a>
                  </li>
                  
                  <li >
                    <a href="../3.3-announcement/index.html">3.3 Announcement</a>
                  </li>
                  
                  <li >
                    <a href="../3.2-announcement/index.html">3.2 Announcement</a>
                  </li>
                  
                  <li >
                    <a href="../3.1-announcement/index.html">3.1 Announcement</a>
                  </li>
                  
                  <li >
                    <a href="../3.0-announcement/index.html">3.0 Announcement</a>
                  </li>
                  
                  <li >
                    <a href="../kickstarter-announcement/index.html">Kickstarter Announcement</a>
                  </li>
                  
                  <li >
                    <a href="../mozilla-grant/index.html">Mozilla Grant</a>
                  </li>
                  
                  <li >
                    <a href="../funding/index.html">Funding</a>
                  </li>
                  
                  <li >
                    <a href="../jobs/index.html">Jobs</a>
                  </li>
                  
                </ul>
              </li>
               

            </ul>
            
          </div>
          <!--/.nav-collapse -->

        </div>
      </div>
    </div>

    <div class="body-content">
      <div class="container-fluid">
        <!-- Search Modal -->
        <div id="mkdocs_search_modal" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true">
          <div class="modal-header">
            <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
            <h3 id="myModalLabel">Documentation search</h3>
          </div>

          <div class="modal-body">
            <form role="form" autocomplete="off">
              <div class="form-group">
                <input type="text" name="q" class="form-control" placeholder="Search..." id="mkdocs-search-query">
              </div>
            </form>
            <div id="mkdocs-search-results"></div>
          </div>

          <div class="modal-footer">
            <button class="btn" data-dismiss="modal" aria-hidden="true">Close</button>
          </div>
        </div>

        <div class="row-fluid">
          <div class="span3">
            <div id="table-of-contents">
              <ul class="nav nav-list side-nav well sidebar-nav-fixed">
                

                
                  <li class="main">
                    <a href="#django-rest-framework-311">Django REST framework 3.11</a>
                  </li>

                  
                    <li>
                      <a href="#openapi-schema-generation-improvements">OpenAPI Schema Generation Improvements</a>
                    </li>
                  
                    <li>
                      <a href="#validator-default-context">Validator / Default Context</a>
                    </li>
                  
                    <li>
                      <a href="#funding">Funding</a>
                    </li>
                  
                

                  <div class="promo">
                    <hr/>
                    <div id="sidebarInclude">
                  </div>
              </ul>

            </div>
          </div>

          <div id="main-content" class="span9">
            
              

              <style>
.promo li a {
    float: left;
    width: 130px;
    height: 20px;
    text-align: center;
    margin: 10px 30px;
    padding: 150px 0 0 0;
    background-position: 0 50%;
    background-size: 130px auto;
    background-repeat: no-repeat;
    font-size: 120%;
    color: black;
}
.promo li {
    list-style: none;
}
</style>

<h1 id="django-rest-framework-311"><a class="toclink" href="#django-rest-framework-311">Django REST framework 3.11</a></h1>
<p>The 3.11 release adds support for Django 3.0.</p>
<ul>
<li>Our supported Python versions are now: 3.5, 3.6, 3.7, and 3.8.</li>
<li>Our supported Django versions are now: 1.11, 2.0, 2.1, 2.2, and 3.0.</li>
</ul>
<p>This release will be the last to support Python 3.5 or Django 1.11.</p>
<h2 id="openapi-schema-generation-improvements"><a class="toclink" href="#openapi-schema-generation-improvements">OpenAPI Schema Generation Improvements</a></h2>
<p>The OpenAPI schema generation continues to mature. Some highlights in 3.11
include:</p>
<ul>
<li>Automatic mapping of Django REST Framework renderers and parsers into OpenAPI
  request and response media-types.</li>
<li>Improved mapping JSON schema mapping types, for example in HStoreFields, and
  with large integer values.</li>
<li>Porting of the old CoreAPI parsing of docstrings to form OpenAPI operation
  descriptions.</li>
</ul>
<p>In this example view operation descriptions for the <code>get</code> and <code>post</code> methods will
be extracted from the class docstring:</p>
<pre><code class="python">class DocStringExampleListView(APIView):
&quot;&quot;&quot;
get: A description of my GET operation.
post: A description of my POST operation.
&quot;&quot;&quot;
    permission_classes = [permissions.IsAuthenticatedOrReadOnly]

    def get(self, request, *args, **kwargs):
        ...

    def post(self, request, *args, **kwargs):
        ...
</code></pre>

<h2 id="validator-default-context"><a class="toclink" href="#validator-default-context">Validator / Default Context</a></h2>
<p>In some circumstances a Validator class or a Default class may need to access the serializer field with which it is called, or the <code>.context</code> with which the serializer was instantiated. In particular:</p>
<ul>
<li>Uniqueness validators need to be able to determine the name of the field to which they are applied, in order to run an appropriate database query.</li>
<li>The <code>CurrentUserDefault</code> needs to be able to determine the context with which the serializer was instantiated, in order to return the current user instance.</li>
</ul>
<p>Previous our approach to this was that implementations could include a <code>set_context</code> method, which would be called prior to validation. However this approach had issues with potential race conditions. We have now move this approach into a pending deprecation state. It will continue to function, but will be escalated to a deprecated state in 3.12, and removed entirely in 3.13.</p>
<p>Instead, validators or defaults which require the serializer context, should include a <code>requires_context = True</code> attribute on the class.</p>
<p>The <code>__call__</code> method should then include an additional <code>serializer_field</code> argument.</p>
<p>Validator implementations will look like this:</p>
<pre><code class="python">class CustomValidator:
    requires_context = True

    def __call__(self, value, serializer_field):
        ...
</code></pre>

<p>Default implementations will look like this:</p>
<pre><code class="python">class CustomDefault:
    requires_context = True

    def __call__(self, serializer_field):
        ...
</code></pre>

<hr />
<h2 id="funding"><a class="toclink" href="#funding">Funding</a></h2>
<p>REST framework is a <em>collaboratively funded project</em>. If you use
REST framework commercially we strongly encourage you to invest in its
continued development by <strong><a href="../funding/index.html">signing up for a paid plan</a></strong>.</p>
<p><em>Every single sign-up helps us make REST framework long-term financially sustainable.</em></p>
<ul class="premium-promo promo">
    <li><a href="https://getsentry.com/welcome/" style="background-image: url(../../../fund-rest-framework.s3.amazonaws.com/sentry130.png)">Sentry</a></li>
    <li><a href="https://getstream.io/try-the-api/?utm_source=drf&amp;utm_medium=banner&amp;utm_campaign=drf" style="background-image: url(../../../fund-rest-framework.s3.amazonaws.com/stream-130.png)">Stream</a></li>
    <li><a href="https://software.esg-usa.com/" style="background-image: url(../../../fund-rest-framework.s3.amazonaws.com/esg-new-logo.png)">ESG</a></li>
    <li><a href="https://rollbar.com/" style="background-image: url(../../../fund-rest-framework.s3.amazonaws.com/rollbar2.png)">Rollbar</a></li>
    <li><a href="https://cadre.com/" style="background-image: url(../../../fund-rest-framework.s3.amazonaws.com/cadre.png)">Cadre</a></li>
    <li><a href="https://hubs.ly/H0f30Lf0" style="background-image: url(../../../fund-rest-framework.s3.amazonaws.com/kloudless-plus-text.png)">Kloudless</a></li>
    <li><a href="https://lightsonsoftware.com/" style="background-image: url(../../../fund-rest-framework.s3.amazonaws.com/lightson-dark.png)">Lights On Software</a></li>
    <li><a href="https://retool.com/?utm_source=djangorest&amp;utm_medium=sponsorship" style="background-image: url(../../../fund-rest-framework.s3.amazonaws.com/retool-sidebar.png)">Retool</a></li>
</ul>

<div style="clear: both; padding-bottom: 20px;"></div>

<p><em>Many thanks to all our <a href="https://fund.django-rest-framework.org/topics/funding/#our-sponsors">wonderful sponsors</a>, and in particular to our premium backers, <a href="https://getsentry.com/welcome/">Sentry</a>, <a href="https://getstream.io/?utm_source=drf&amp;utm_medium=banner&amp;utm_campaign=drf">Stream</a>, <a href="https://software.esg-usa.com/">ESG</a>, <a href="https://rollbar.com/?utm_source=django&amp;utm_medium=sponsorship&amp;utm_campaign=freetrial">Rollbar</a>, <a href="https://cadre.com/">Cadre</a>, <a href="https://hubs.ly/H0f30Lf0">Kloudless</a>, <a href="https://lightsonsoftware.com/">Lights On Software</a>, and <a href="https://retool.com/?utm_source=djangorest&amp;utm_medium=sponsorship">Retool</a>.</em></p>
            

          </div> <!--/span-->
        </div> <!--/row-->
      </div> <!--/.fluid-container-->
    </div> <!--/.body content-->
    <div id="push"></div>
  </div> <!--/.wrapper -->

  <footer class="span12">
    <p>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.
    </p>
  </footer>

  <!-- Le javascript
  ================================================== -->
  <!-- Placed at the end of the document so the pages load faster -->
  <script async src="../../../fund.django-rest-framework.org/sidebar_include.js"></script>
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
  <script src="../../js/theme.js"></script>

  <script>var base_url = '../../index.html';</script>
  
  <script src="../../search/main.js" defer></script>
  

  <script>
    var shiftWindow = function() {
      scrollBy(0, -50)
    };

    if (location.hash) shiftWindow();
    window.addEventListener("hashchange", shiftWindow);

    $('.dropdown-menu').on('click touchstart', function(event) {
      event.stopPropagation();
    });

    // Dynamically force sidenav/dropdown to no higher than browser window
    $('.side-nav, .dropdown-menu').css('max-height', window.innerHeight - 130);

    $(function() {
      $(window).resize(function() {
        $('.side-nav, .dropdown-menu').css('max-height', window.innerHeight - 130);
      });
    });
  </script>
</body>


<!-- Mirrored from www.django-rest-framework.org/community/3.11-announcement/ by HTTrack Website Copier/3.x [XR&CO'2014], Sun, 13 Sep 2020 09:33:14 GMT -->
</html>